Get LID by Phone
Convert a phone number to its corresponding WhatsApp LID.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Call this when onboarding a new contact to complete your database record.
Gracefully handle cases where no LID is returned.
The Stable Anchor: Phone to LID
The /v2/lids/pn/{number} endpoint performs a forward lookup, converting a traditional phone number into its corresponding privacy-preserving Lookup ID (LID).
🔮 Why This Matters
In the modern WhatsApp ecosystem, phone numbers are ephemeral but identities should be persistent.
- The Problem: A user changes their number from
+1-555-1234to+44-7700-900000. - Old System: You lose track of them. Their chat history is orphaned.
- New System: You query their LID using the old number, store it, then when they message you from the new number, you query the LID again and realize it's the same person.
🛠️ Implementation Pattern
The "Identity Merge" Workflow
- User A messages you from
15551234567@c.us. - You call
/v2/lids/pn/15551234567. - Response:
{ lid: "999888777@lid", number: "15551234567" }. - You store in DB:
user_id = 999888777@lid, current_phone = 15551234567. - 6 months later: User A changes their number to
447700900000. - They message you again from
447700900000@c.us. - You call
/v2/lids/pn/447700900000. - Response:
{ lid: "999888777@lid", number: "447700900000" }. - Match Found: The LID is the same! You update
current_phonebut keep the sameuser_id. - Result: Chat history, preferences, and purchase records are preserved.
⚠️ Availability
Not every phone number has an LID.
- Modern Accounts: Created after 2023 usually have LIDs.
- Legacy Accounts: Very old accounts might return
null. - Best Practice: Always handle the case where this endpoint returns no LID. Fall back to using the
@c.usJID as the primary key if necessary.
🚦 Performance
- Caching: The mapping is relatively stable. Cache the result for at least 7 days.
- Latency: ~100-300ms for a fresh lookup.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
URL Parameters
Passed in the URL query stringstring | Your unique WhatsApp Instance ID Example: | ||
string | Your API Access Token Example: | ||
string | The phone number without @c.us (e.g. 201234567890) Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"lid": "1234567890@lid",
"number": "201234567890"
}Command Palette
Search for a command to run...